home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / prevnt23.arc / PREVENT.DOC < prev    next >
Encoding:
Text File  |  1990-09-26  |  7.9 KB  |  186 lines
  1. PREvent 2.20
  2. PCBoard Rotary Event Manager
  3. Release 09-07-90
  4. by Jeff Woods
  5.  
  6. ___________________________________________________________________
  7.  
  8. Sorry for the short time between releases.   2.2 is only a bug fix
  9. version, no new features.   There was a logic error in determining if an
  10. event was to run on a given day.   The bug would occur when run with the
  11. next event was higher up in the data file than the current event.  In
  12. that case, it SHOULD have been checking the NEXT day for if the event is
  13. to occur, but instead, it was checking the CURRENT day.   This has been
  14. fixed.   On the same note, 2.3, released a few hours later (hopefully no
  15. one got 2.2) now supports 14.0, 14.1, and 14.2 PCBoard.DAT files.
  16.  
  17. ___________________________________________________________________
  18.  
  19.  
  20. The format of the data file has been changed again to accomodate day of
  21. the week specific events.   Now you may have an event execute ONLY on a
  22. give day (or list of days) of the week.   If you want an event to run
  23. only on Mondays, or only on Monday, Wednesday and Friday, Prevent will
  24. do it.
  25.  
  26. Here is the new format.   Unless you read these docs from earliest
  27. release to latest, this may be confusing, so make sure you understand
  28. the changes to 2.0 from 1.0.   The comments below are for the
  29. documentation only, and Prevent will NOT run if they are left in the
  30. runtime config file.
  31.  
  32. 4                     <-  First line MUST be the total number of events
  33. 012356                <-  Days of the week for event # 1
  34. 02:30,y,2,n,10        <-  Event information for event # 1
  35. a                     <-  Days of the week for event # 2
  36. 04:30,y,20,y,3        <-  Event information for event # 2
  37. 123564                <-  Days of the week for event # 3
  38. 12:00,n,2,n,100
  39. 012356                    etc......
  40. 23:57,y
  41.  
  42.  
  43.  
  44. Days of the week are as follows, and may appear on the line in any
  45. order.    PREvent does not care.   01234 is the same as 40231.
  46.  
  47.                 0 - Sunday        4 - Thursday
  48.                 1 - Monday        5 - Friday
  49.                 2 - Tuesday       6 - Saturday
  50.                 3 - Wednesday     A - Every day
  51.  
  52. Note that an "A" ANYWHERE on the days line for an event will override
  53. any other information.    Thus 01A2 will still run Wednesday through
  54. Saturday even though 3456 is not on the command line.
  55.  
  56. The second line for each event remains unchanged from version 2.0.
  57. Information on that is contained below in the release notes for version
  58. 2.0.    Keep those requests coming!
  59.  
  60.  
  61. ___________________________________________________________________
  62.  
  63. What's new in 2.00?   A whole lot.   It has been:
  64.  
  65. Updated to handle variable size PCBoard.DAT files, up to 300 lines long.
  66. (David Terry, if you EVER exceed this....... ;-)
  67.  
  68. Updated to display full help for your event data file when errors occur.
  69.  
  70. Updated to not be hardcoded for the data file.   Now you can have
  71. multiple data files, and pass the name of it in on the command line.
  72. If none is passed, it assumes the old standard, PREVENT.LST in the same
  73. directory as PCBoard.DAT.
  74.  
  75. Here are the ones you've all asked for:
  76.  
  77. Now handles each event as unique with it's own option to slide, time to
  78. suspend before the event, option to disallow uploads beforehand, and for
  79. how long it will disallow uploads.   The new format for the data file is
  80. as follows:
  81.  
  82.   ┌────────────────────────  Hour and minute of Next Event    e.g. 02:00');
  83.   │   ┌────────────────────  Slide This Event?  ( Y,N )
  84.   │   │ ┌──────────────────  Minutes prior to event to suspend? ( 0 - 99 )
  85.   │   │ │ ┌────────────────  Disallow uploads prior to event?   ( Y,N )
  86.   │   │ │ │ ┌──────────────  Minutes prior to stop allowing uploads? ( 0 - 99 )
  87.   │   │ │ │ │
  88.         
  89.  
  90. hh:mm,N,5,Y,10
  91.  
  92. The first parameter, the hh:mm, is the only required parameter, and MUST
  93. contain five digits.   All others are optional, but must be in that order.
  94. If you want to disallow uploads 10 minutes before, you MUST also specify a
  95. sliding and minutes to suspend value.   If you do not supply a sliding time,
  96. no others will take effect, and so on down the chain.
  97.  
  98. Thus:
  99.  
  100. 02:00,N,10   sets the next event at 2 am with no sliding, and suspends
  101.              activity 10 minutes prior.
  102.  
  103. 15:00,Y,0,Y,30  will set an event for 3 pm, slide it, but will stop all
  104.                 uploads 30 minutes before three.
  105.  
  106. 23:00        simply sets the next event to 11 pm, leaving all other
  107.              params as they were.
  108.  
  109. ________________________________________________________________________
  110.  
  111.  
  112. What's new in 1.10?   Not much at all.   It's only updated to handle the
  113. new PCBoard 14.5 .DAT files, which have new entries.   I've been REAL
  114. busy as of late.   Sometime in the next month I expect to have all
  115. options working for the system, including sliding event times, minutes
  116. to suspend, and disallowing of uploads options (and how long before).
  117. I hope to have that out and ready by September 20th, so bear with me.
  118. Moving to Canada has taken a toll on my time to develop.
  119.  
  120. ____________________________________________________________________
  121.  
  122.  
  123. Version 1.0, initial release
  124.  
  125. With the release of PCBoard 14.5, I found my multiple event program
  126. trashed, and my need for multiple events still existing.    It was a
  127. two hour job to write this, so I hereby dedicate PREvent to the
  128. public domain.   If your conscience bothers you so much that you can't
  129. use a program without paying for it, give Telix a plug to a friend.
  130.  
  131. PREvent is very simple and straightforward.   It uses a data file to
  132. read in a list of your event times in chronological order, and matches
  133. them against PCBoard.DAT to determine the next time.
  134.  
  135. This file, PREVENT.LST is simple.   The first line is the number of
  136. events you wish to run, and the remaining lines are those of the event
  137. times.   For example, I have three events, one at just before midnight,
  138. one at 2:30 am, and one at 4:00 am.   My PREVENT.LST file looks like
  139. this (and is the same as the one included here):
  140.  
  141. 3
  142. 02:30
  143. 04:00
  144. 23:57
  145.  
  146. Note that order is important.   The order MUST be chronological,
  147. starting with 00:02 (the earliest possible event time) and ending with
  148. the latest, 23:58.   All times must be in military format.   The .LST
  149. file may contain up to 48 differenct event times.   Place this file in
  150. your PCBoard system directory, the same one where PCBoard.DAT resides.
  151. This is usually something like D:\PCB.
  152.  
  153. Place PREVENT.EXE in your PCBoard system directory also.   No parameters
  154. are required to run PREvent.   Just include the command:
  155.  
  156. PREVENT
  157.  
  158. in your EVENT.SYS and off it goes.
  159.  
  160. PREvent returns an error level based on the event it runs.  In the above
  161. example, the 2:30 event returns an errorlevel of 1 when exiting, the
  162. 4:00 event returns errorlevel 2, and the 23:57 returns 3.   Any error
  163. returns errorlevel 0.   You can use these errorlevels in your EVENT.SYS
  164. file to take the appropriate action.   Thus, if errorlevel 1 is
  165. returned, you know that the 2:30 event was just placed into PCBoard.DAT,
  166. thus the event you want to run is the one at 23:57, and can call the
  167. according batch file.   I hope that's not too confusing.
  168.  
  169. PREvent works ONLY on PCBoard 14.5.   Any attempt to use it on earlier
  170. version are not warranted.   It should not change anything in such a
  171. case and will return an error level of zero, but no guarantees.
  172.  
  173. And now for the legal, boring stuff.   I left it until the end, so if
  174. you don't care to read this, oh, well.   It was here.
  175.  
  176. Jeff Woods nor the Musical Chair warrants any part of this program.   It
  177. is provided free, and as such, any damages it may cause to files,
  178. hardware, or incidental damages such as lost time or wages, are not my
  179. responsibility.   Or, in short, I cannot be held responsible for any
  180. damages resulting from the use (or mis-use) of this program.
  181.  
  182. As with all software, you should backup your PCBoard.DAT file before
  183. trying this the first time.   The latest version is always available for
  184. downloading from the Musical Chair at 416-438-3009, running an HST Dual
  185. Standard.
  186.